# 1-Offer API
# 简介
Offer API为开发者提供了通过Server to Server (S2S)方式拉取广告offer的方法, 开发者在对接该API接口时应注意:
- 需通过GET方式请求该接口,数据结果会以JSON格式返回
- 需在服务端请求该接口,而不应从客户端直接请求
- 为保证offer实效性,建议开发者每10-15分钟请求一次该接口,但不得过于频繁请求
# 对接说明
# 接口请求
- 请求地址
https://offer-api.rethinkad.com/v1/offer-api/offers?app_id={APP_ID}&app_key={APP_KEY}&page_size={NUM}&page_no={NUM}
请求方法 GET
请求参数
参数 | 描述 | 必传 |
---|---|---|
app_id | APP ID,需要从AM处获取 | 是 |
app_key | APP Key,需要从AM处获取 | 是 |
page_size | 单页数量,默认500,限制不大于500 | 否 |
page_no | 页码,默认值1 | 否 |
- 请求示例
https://offer-api.rethinkad.com/v1/offer-api/offers?app_id=10000&app_key=xxxxx-xxxx-xxxxx&page_size=2&page_no=1
# 接口响应
- 响应参数
参数 | 类型 | 描述 |
---|---|---|
code | int | 请求结果,0-success,非0表示请求失败(如:20001-参数错误) |
msg | string | 响应信息,"OK"表示拉取成功,code非0时表示请求失败的原因 |
data | json object | 返回数据详情,json |
- data object (返回数据详情)
参数 | 类型 | 描述 |
---|---|---|
total_count | int | 渠道总offer数,用于参考分页 |
page_no | int | 当前页数 |
offers | object[ ] | offer详情,数组 |
- Offer Object(Offer 详情)
参数 | 类型 | 描述 |
---|---|---|
status | int | 状态码,1-success |
id | string | offer id |
name | string | offer名称 |
app_name | string | 推广应用名称 |
pkg_name | string | 推广应用包名 |
description | string | 订单描述 |
icon | string | 推广应用icon |
payout_model | string | 出价类型:CPI |
payout | string | 价格,保留两位小数 |
currency | string | 货币类型:“USD” |
daily_cap | string | 日限量,“”表示不限制 |
kpi | string | KPI备注信息 |
expiration_date | string | 过期时间,UTC时间 |
preview_link | string | 推广应用Google Play地址 |
tracking_link | string | 投放追踪链接 |
black_channel | string | 预留字段,表示黑名单,返回值为包名,逗号分隔 |
white_channel | string | 预留字段,表示白名单,返回值为包名,逗号分隔 |
creatives | object | 预留字段 |
targeting | object | 用户定向 |
geo | string[ ] | 投放定向的国家,"Global"表示定向全球,[IN,ID] 表示定向印度和印尼 |
geo_exclude | string[ ] | 投放排除的国家,为“”时,表示不限制, [IN,ID]表示排除印度和印尼 |
os | string | “android”, “ios” |
os_vers | string | 操作系统版本定向,“”表示不限制 |
- 返回示例
{
"code": 0,
"data": {
"offers": [
{
"id": 1392411,
"name": "com.igg.android.lordsmobile_US",
"pkg_name": "com.igg.android.lordsmobile",
"app_name": "王国纪元",
"description": "",
"icon": "http://static.rarrao.com/apps/2022-12-08/com.igg.android.lordsmobile-1670509225.png",
"payout_model": "CPI",
"payout": "2.67",
"currency": "USD",
"daily_cap": "20",
"kpi": "cvr 0.2% 3D ROI>1% Day2 Retention>20% Sign Up Rate >85%",
"expiration_date": "2099-12-31",
"preview_link": "https://play.google.com/store/apps/details?id=com.igg.android.lordsmobile&hl=en&gl=US",
"tracking_link": "http://api.rethinkad.com/moonlight/v4?value=5146ea64xxx&click_id={click_id}&affiliate_id={affiliate_id}&idfa={idfa}&gaid={gaid}&imei={imei}&android_id={android_id}&mac={mac}&oaid={oaid}&ua={ua}&os_version={os_version}&device_model={device_model}&ip={ip}&country_code={country_code}&ext={ext}",
"black_channel": "",
"white_channel": "",
"status": 1,
"targeting": {
"geo": [
"US"
],
"geo_exclude": [
""
],
"os": "android",
"os_vers": ""
}
},
{
"id": 1388670,
"name": "com.merge.rainbow.as_Global",
"pkg_name": "com.merge.rainbow.as",
"app_name": "Merge Fusion: Rainbow Friends",
"description": "",
"icon": "http://static.rarrao.com/apps/2022-09-19/com.merge.rainbow.as-1663578564.png",
"payout_model": "CPI",
"payout": "0.26",
"currency": "USD",
"daily_cap": "",
"kpi": "cvr 0.2%",
"expiration_date": "2099-12-31",
"preview_link": "https://play.google.com/store/apps/details?id=com.merge.rainbow.as&hl=en",
"tracking_link": "http://api.rethinkad.com/moonlight/v4?value=5146ea64xxx&click_id={click_id}&affiliate_id={affiliate_id}&idfa={idfa}&gaid={gaid}&imei={imei}&android_id={android_id}&mac={mac}&oaid={oaid}&ua={ua}&os_version={os_version}&device_model={device_model}&ip={ip}&country_code={country_code}&ext={ext}",
"black_channel": "",
"white_channel": "",
"status": 1,
"targeting": {
"geo": [
"Global"
],
"geo_exclude": [
"MY",
"SA",
"CL",
"VN",
"BR",
"TH",
"RU",
"IT",
"ID",
"TR",
"AR",
"MX"
],
"os": "android",
"os_vers": ""
}
}
],
"page_no": 1,
"total_count": 2
},
"msg": "OK"
}